cs-security-experience-api-services
📘 Documentación de la API - Servicio de Seguridad de Experiencia
Esta sección describe los atributos y uso del Servicio de Integración de Pagos PayU.
💂️ Información Base
- Título de la API: Servicio de Integración de Pagos PayU
- Versión: 1.0.0-SNAPSHOT
- URL Base:
https://cs-payu-sapi-{env}.us-e1.cloudhub.io/api/
Reemplaza {env} con:
qa(Aseguramiento de Calidad)prod(Producción)
🔑 Autenticación
Encabezados Requeridos
| Encabezado | Tipo | Descripción |
|---|---|---|
| Authorization | String | Token Bearer en el formato Bearer {{API_KEY}} |
| client_id | String | Identificador único para clientes de API |
| X-Correlation-ID | String | Identificador de correlación (opcional) |
- Authorization
- Longitud: 36 - 200 caracteres
- Ejemplo:
Bearer abcdefghijklmnopqrstuvwxyz1234567890
- client_id
- Longitud: 32 - 36 caracteres
- Ejemplo:
123e4567-e89b-12d3-a456-426614174000
- X-Correlation-ID
- Longitud: 36 caracteres (UUID)
- Ejemplo:
550e8400-e29b-41d4-a716-446655440000
📌 Los encabezados
Authorizationyclient_idson requeridos en todas las solicitudes.
💳 Endpoint: Pago con Tarjeta de Crédito
POST /payments/credit-card
- Descripción: Procesa un pago con tarjeta de crédito o débito en tiempo real.
Campos Principales
transaction.order: Información de la orden (accountId, referenceCode, description, buyer, TX_VALUE)transaction.creditCard: Datos de tarjeta (number, securityCode, expirationDate, name)transaction.payer: Información del pagadortransaction.type: AUTHORIZATION_AND_CAPTUREtransaction.paymentMethod: VISA, MASTERCARD, etc.
🏦 Endpoint: Pago PSE
POST /payments/PSE
- Descripción: Procesa un pago mediante PSE (Pagos Seguros en Línea) con bancos colombianos.
Campos Principales
transaction.order: Información de la ordentransaction.payer: Datos del pagadortransaction.extraParameters: FINANCIAL_INSTITUTION_CODE, USER_TYPE (N/J), PSE_REFERENCE1-3transaction.paymentMethod: PSE
💰 Endpoint: Pago en Efectivo
POST /payments/cash-or-referenced
- Descripción: Genera referencia de pago en efectivo para puntos físicos.
Campos Principales
transaction.order: Información de la ordentransaction.paymentMethod: BALOTO, EFECTYtransaction.type: AUTHORIZATION_AND_CAPTURE
🔐 Endpoint: Crear Token de Tarjeta
POST /credit-card/tokens
- Descripción: Crea y almacena un token de tarjeta para pagos recurrentes.
Campos Principales
payerId: ID del pagador (requerido)name: Nombre del tarjetahabiente (requerido)identificationNumber: Número de identificación (requerido)paymentMethod: VISA, MASTERCARD (requerido)number: Número de tarjeta (requerido)expirationDate: Formato YYYY/MM (requerido)
🔍 Endpoint: Consultar Tokens
GET /credit-card/tokens
- Parámetros:
payerId,identificationNumber - Respuesta: Lista de tokens con información enmascarada
🗑️ Endpoint: Eliminar Token
DELETE /credit-card/tokens/{tokenId}
- Parámetro:
tokenId(UUID del token) - Respuesta: Confirmación de eliminación
💸 Endpoint: Reembolsos
POST /refunds
- Descripción: Reembolso total de una transacción.
POST /partial-refunds
- Descripción: Reembolso parcial de una transacción.
Campos Principales
transaction.order.id: ID de orden originaltransaction.type: REFUNDtransaction.reason: Motivo del reembolsotransaction.parentTransactionId: ID de transacción originaltransaction.additionalValues.TX_VALUE: Monto a reembolsar (solo parcial)
🏦 Endpoint: Consultar Bancos PSE
GET /PSE/banks
- Descripción: Listado de bancos disponibles para PSE.
- Respuesta: Array con
pseCodeydescription
📊 Endpoint: Reportes
GET /reports
- Parámetros:
startDate,endDate,reportType - Respuesta: Reporte de transacciones en el período
📋 Endpoint: Métodos de Pago
GET /payments/available-methods
- Parámetro:
accountId - Respuesta: Lista de métodos de pago disponibles
📦 Endpoints de Procesamiento Masivo
| Endpoint | Método | Formatos | Descripción |
|---|---|---|---|
/credit-card/tokens/bulk/registration | POST | JSON, CSV, Binary | Registro masivo de tokens |
/credit-card/tokens/bulk | DELETE | JSON, CSV, Binary | Eliminación masiva de tokens |
/payments/bulk-tokens | POST | JSON, CSV, Binary | Pagos masivos con tokens |
Formato CSV: tokenId,referenceCode,description,amount,currency,buyerEmail
📊 Parámetros Comunes
| Parámetro | Tipo | Descripción | Requerido |
|---|---|---|---|
client_id | String | Identificador del cliente de API | ✅ |
Authorization | String | Token Bearer para autenticación | ✅ |
X-Correlation-ID | String | ID de correlación para trazabilidad | ❌ |
🔐 Esquemas de Seguridad
Aplicación de Client ID
| Campo | Tipo | Requerido | Longitud | Regex |
|---|---|---|---|---|
client_id | String | Sí | 32 - 36 | [a-zA-Z0-9-] |
client_secret | String | Sí | 32 - 64 | [a-zA-Z0-9] |
OAuth 2.0
| Campo | Tipo | Requerido | Longitud | Regex |
|---|---|---|---|---|
Authorization | String | Sí | 36 - 200 | [a-zA-Z0-9-_.] |
⚠️ Códigos de Error
| Código | Descripción | Solución Sugerida |
|---|---|---|
| 200 | Éxito | Transacción procesada correctamente |
| 400 | Solicitud Incorrecta | Revisar sintaxis de solicitud y parámetros requeridos |
| 401 | No Autorizado | Validar credenciales de autenticación OAuth |
| 403 | Prohibido | Verificar permisos del client_id |
| 404 | No Encontrado | Confirmar la URL del endpoint y recursos solicitados |
| 422 | Entidad No Procesable | Transacción rechazada por la pasarela de pagos |
| 429 | Demasiadas Solicitudes | Reducir frecuencia de requests, implementar rate limiting |
| 500 | Error Interno del Servidor | Reintentar o contactar soporte técnico |
| 503 | Servicio No Disponible | Servicio en mantenimiento, reintentar más tarde |
| 504 | Timeout de Gateway | Consultar estado de transacción antes de reintentar |
🔢 Tipos de Transacción
| Tipo | Descripción |
|---|---|
AUTHORIZATION | Autorización de pago sin captura |
CAPTURE | Captura de pago previamente autorizado |
AUTHORIZATION_AND_CAPTURE | Autorización y captura en una sola operación |
REFUND | Reembolso de transacción |
VOID | Anulación de transacción |
💳 Métodos de Pago Soportados
| Método | Código | País | Descripción |
|---|---|---|---|
| Visa | VISA | CO | Tarjeta de crédito/débito Visa |
| Mastercard | MASTERCARD | CO | Tarjeta de crédito/débito MC |
| American Express | AMEX | CO | Tarjeta de crédito Amex |
| Diners Club | DINERS | CO | Tarjeta de crédito Diners |
| PSE | PSE | CO | Pagos Seguros en Línea |
| Baloto | BALOTO | CO | Pago en efectivo Baloto |
| Efecty | EFECTY | CO | Pago en efectivo Efecty |
📞 Soporte
Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.
Correo electrónico: epalma@fgs.co
📅 Información Adicional
Documentación generada y actualizada en Noviembre 2025 por epalma@fgs.co - Edna Nayibe Palma
© 2025 Fundación Grupo Social - Colmena. API cs-payu-sapi
📋 Nota Importante: Esta documentación se actualiza continuamente. Para la versión más reciente y cambios en tiempo real, consulta siempre el Portal de Exchange oficial.
🔒 Aviso de Seguridad: Nunca compartas credenciales de API en repositorios públicos o documentación. Usa siempre variables de entorno para información sensible y rota tokens regularmente. Cumple con PCI-DSS al manejar datos de tarjetas.
💳 Aviso Legal: El procesamiento de pagos está sujeto a términos y condiciones de la pasarela de pagos PayU. Las transacciones pueden estar sujetas a comisiones según el método de pago y configuración del comercio.